看了我的 mybatis |
您所在的位置:网站首页 › spring page 从1开始 › 看了我的 mybatis |
我就默认其他环境已经准备好了,咱们直接从mybatis-plus开始。 1.1 依赖准备 想要什么依赖版本的去maven仓库查看:https://mvnrepository.com/ 引入mybatis-plus依赖: < dependency> < groupId> com.baomidou < artifactId> mybatis-plus-boot-starter < version> 3.5.0
引入mysql依赖: < dependency> < groupId> mysql < artifactId> mysql-connector-java < version> 8.0.27
目前,多数项目会有多数据源的要求,或者是主从部署的要求,所以我们还需要引入mybatis-plus关于多数据源的依赖: < dependency> < groupId> com.baomidou < artifactId> dynamic-datasource-spring-boot-starter < version> 3.5.0
1.2 配置准备 springboot启动类。配置@MapperScan注解,用于扫描Mapper文件位置: importorg.mybatis.spring.annotation.MapperScan; importorg.springframework.boot.SpringApplication; importorg.springframework.boot.autoconfigure.SpringBootApplication; importorg.springframework.cloud.client.discovery.EnableDiscoveryClient; @EnableDiscoveryClient @MapperScan( "com.wjbgn.user.mapper") @SpringBootApplication publicclassRobNecessitiesUserApplication{ publicstaticvoidmain(String[] args){ SpringApplication.run(RobNecessitiesUserApplication . class, args) ; } } 数据源配置,此处配置一主一从的环境,当前我只有一台,所以此处配置一样的: spring: datasource: dynamic: primary:master#设置默认的数据源或者数据源组,默认值即为master strict:false#严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源 datasource: master: url:jdbc:mysql://127.0.0.1:3306/rob_necessities?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai username:root password:123456 slave_1: url:jdbc:mysql://127.0.0.1:3306/rob_necessities?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai username:root password:123456 补充:这里面因为默认使用的是 HikariCP数据源,目前也推荐使用这个,相比于druid有更高的性能,但是不能忽略下面的配置,否则服务会不断抛出异常,原因是数据库的连接时常和连接池的配置没有做好。 spring: datasource: dynamic: hikari: max-lifetime:1800000 connection-timeout:5000 idle-timeout:3600000 max-pool-size:12 min-idle:4 connection-test-query:/**ping*/ 1.3 启动服务 下面直接启动服务: 得到如上结果表示启动成功了。 二、使用 前面我们成功的集成进来了mybatis-plus,配合springboot使用不要太方便。下面我们看看如何使用它来操作我们的数据库。介绍一下常规的用法。 2.1 实体类注解 mybatis-plus为使用者封装了很多的注解,方便我们使用,我们首先看下实体类中有哪些注解。有如下的实体类: @TableName(value = "user") publicclassUserDO{ /** * 主键 */ @TableId(value = "id", type = IdType.AUTO) privateLong id; /** * 昵称 */ @TableField( "nickname") privateString nickname; /** * 真实姓名 */ privateString realName; } @TableName 表名注解,用于标识实体类对应的表。其说明如下,关于这些书写,常规情况基本很少用到,不做多余解释了: @TableName 表名注解,用于标识实体类对应的表。其说明如下,关于这些书写,常规情况基本很少用到,不做多余解释了: @Documented @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE}) public@interfaceTableName { /** * 实体对应的表名 */ String valuedefault"" ; /** * schema * * @since3.1.1 */ String schemadefault"" ; /** * 是否保持使用全局的 tablePrefix 的值 * 只生效于 既设置了全局的 tablePrefix 也设置了上面 { @link#value} 的值 * 如果是 false , 全局的 tablePrefix 不生效 * * @since3.1.1 */ booleankeepGlobalPrefixdefaultfalse; /** * 实体映射结果集, * 只生效与 mp 自动注入的 method */ String resultMapdefault"" ; /** * 是否自动构建 resultMap 并使用, * 只生效与 mp 自动注入的 method, * 如果设置 resultMap 则不会进行 resultMap 的自动构建并注入, * 只适合个别字段 设置了 typeHandler 或 jdbcType 的情况 * * @since3.1.2 */ booleanautoResultMapdefaultfalse; /** * 需要排除的属性名 * * @since3.3.1 */ String[] excludeProperty default{}; } @TableId 主键注解,看看其源码: @TableId 主键注解,看看其源码: @Documented @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE}) public@interfaceTableId { /** * 字段值(驼峰命名方式,该值可无) */ String valuedefault"" ; /** * 主键ID * { @linkIdType} */ IdType typedefaultIdType.NONE ; } 其中IdType很重要: 名称 描述 AUTO 数据库自增ID NONE 该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT) INPUT 用户自己设置的ID ASSIGN_ID 当用户传入为空时,自动分配类型为Number或String的主键(雪花算法) ASSIGN_UUID 当用户传入为空时,自动分配类型为String的主键 @TableFiled 表字段标识,下面看看其主要常用属性: 名称 描述 value 数据库字段名 condition 字段 where实体查询比较条件,通过SqlCondition设置 如果未设置条件,则按照正常相等来查询 若设置则按照以下规则: 等于:EQUAL = "%s=#{%s}"; 不等于:NOT_EQUAL = "%s#{%s}"; 左右模糊:LIKE = "%s LIKE CONCAT('%%',#{%s},'%%')"; oracle左右模糊ORACLE_LIKE = "%s LIKE CONCAT(CONCAT('%%',#{%s}),'%%')"; 左模糊:LIKE_LEFT = "%s LIKE CONCAT('%%',#{%s})"; 右模糊:LIKE_RIGHT = "%s LIKE CONCAT(#{%s},'%%')"; fill 自动填充策略,通过FieldFill设置 不处理:FieldFill.DEFAULT 插入时填充字段:FieldFill.INSERT 更新时填充字段:FieldFill.UPDATE 插入或新增时填充字段:FieldFill.INSERT_UPDATE 关于其他的属性,我不太推荐使用,用得越多,越容易蒙圈。可以通过wapper查询去设置。 @TableFiled 表字段标识,下面看看其主要常用属性: 名称 描述 value 数据库字段名 condition 字段 where实体查询比较条件,通过SqlCondition设置 如果未设置条件,则按照正常相等来查询 若设置则按照以下规则: 等于:EQUAL = "%s=#{%s}"; 不等于:NOT_EQUAL = "%s#{%s}"; 左右模糊:LIKE = "%s LIKE CONCAT('%%',#{%s},'%%')"; oracle左右模糊ORACLE_LIKE = "%s LIKE CONCAT(CONCAT('%%',#{%s}),'%%')"; 左模糊:LIKE_LEFT = "%s LIKE CONCAT('%%',#{%s})"; 右模糊:LIKE_RIGHT = "%s LIKE CONCAT(#{%s},'%%')"; fill 自动填充策略,通过FieldFill设置 不处理:FieldFill.DEFAULT 插入时填充字段:FieldFill.INSERT 更新时填充字段:FieldFill.UPDATE 插入或新增时填充字段:FieldFill.INSERT_UPDATE 关于其他的属性,我不太推荐使用,用得越多,越容易蒙圈。可以通过wapper查询去设置。 mybatis-plus封装好了一条接口供我们直接调用。关于内部的具体方法,在使用时候自己体会吧,此处不列举了。 2.2.1 Service层CRUD 我们使用的时候,需要在自己定义的service接口当中继承IService接口: importcom.baomidou.mybatisplus.extension.service.IService; importcom.wjbgn.user.entity.UserDO; /** * @deion: 用户服务接口 * @author:weirx * @date:2022/1/17 15:02 * @version:3.0 */ publicinterfaceIUserServiceextendsIService< UserDO> { } 同时要在我们的接口实现impl当中继承ServiceImpl,实现自己的接口: importcom.baomidou.mybatisplus.extension.service.impl.ServiceImpl; importcom.wjbgn.user.entity.UserDO; importcom.wjbgn.user.mapper.UserMapper; importcom.wjbgn.user.service.IUserService; /** * @deion: 用户接口实现 * @author:weirx * @date:2022/1/17 15:03 * @version:3.0 */ publicclassUserServiceImplextendsServiceImpl< UserMapper, UserDO> implementsIUserService{ } 2.2.2 Mapper层CRUD mybatis-plus将常用的CRUD接口封装成了BaseMapper接口,我们只需要在自己的Mapper中继承它就可以了: /** * @deion: 用户mapper * @author:weirx * @date:2022/1/17 14:55 * @version:3.0 */ @Mapper publicinterfaceUserMapperextendsBaseMapper< UserDO> { } 2.3 分页 使用分页话需要增加分页插件的配置: importcom.baomidou.mybatisplus.annotation.DbType; importcom.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor; importcom.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor; importorg.mybatis.spring.annotation.MapperScan; importorg.springframework.context.annotation.Bean; importorg.springframework.context.annotation.Configuration; @Configuration @MapperScan( "com.wjbgn.*.mapper*") publicclassMybatisPlusConfig{ @Bean publicMybatisPlusInterceptor mybatisPlusInterceptor{ MybatisPlusInterceptor interceptor = newMybatisPlusInterceptor; interceptor.addInnerInterceptor( newPaginationInnerInterceptor(DbType.MYSQL)); returninterceptor; } } 如上配置后,我们直接使用分页方法就行。 2.4 逻辑删除配置 很多情况下我们的系统都需要逻辑删除,方便恢复查找误删除的数据。 通过mybatis-plus可以通过全局配置的方式,而不需要再去手动处理。针对更新和查询操作有效,新增不做限制。 通常以我的习惯逻辑删除字段通常定义为is_delete,在实体类当中就是isDelete。那么在配置文件中就可以有如下的配置: mybatis-plus: global-config: db-config: logic-delete-field:isDelete# 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2) logic-delete-value:1# 逻辑已删除值(默认为 1) logic-not-delete-value:0# 逻辑未删除值(默认为 0) 或者通过注解@TableLogic @TableLogic privateInteger isDelete; 2.5 通用枚举配置 相信后端的同学都经历过一个情况,比如性别这个字段,分别值和名称对应1男、2女,这个字段在数据库时是数值类型,而前端展示则是展示字符串的名称。有几种常见实现方案呢? 数据库查询sql通过case判断,返回名称,以前oracle经常这么做 数据库返回的值,重新遍历赋值进去,这时候还需要判断这个值到底是男是女。 前端写死,返回1就是男,返回2就是女。 数据库查询sql通过case判断,返回名称,以前oracle经常这么做 数据库返回的值,重新遍历赋值进去,这时候还需要判断这个值到底是男是女。 前端写死,返回1就是男,返回2就是女。 相信无论哪种方法都有其缺点,所以我们可以使用mybatis-plus提供的方式。我们在返回给前端时: 只需要在遍历时get这个枚举,直接赋值其名称,不需要再次判断。 直接返回给前端,让前端去去枚举的name 只需要在遍历时get这个枚举,直接赋值其名称,不需要再次判断。 直接返回给前端,让前端去去枚举的name 这样大家都不需要写死这个值。 下面看看如何实现这个功能: 性别枚举,实现IEnum接口: 性别枚举,实现IEnum接口: importcom.baomidou.mybatisplus.annotation.IEnum; importcom.fasterxml.jackson.annotation.JsonFormat; /** * @deion: 性别枚举 * @author:weirx * @date:2022/1/17 16:26 * @version:3.0 */ @JsonFormat(shape = JsonFormat.Shape.OBJECT) publicenumSexEnum implements IEnum { MAN( 1, "男"), WOMAN( 2, "女"); privateInteger code; privateString name; SexEnum(Integer code, String name) { this.code = code; this.name = name; } @Override publicInteger getValue{ returncode; } publicString getName{ returnname; } } @JsonFormat注解为了解决枚举类返回前端只展示构造器名称的问题。 实体类性别字段 实体类性别字段 @TableName(value = "user") publicclassUserDO{ /** * 主键 */ @TableId(value = "id", type = IdType.AUTO) privateLong id; /** * 昵称 */ @TableField(value = "nickname",condition = SqlCondition.EQUAL) privateString nickname; /** * 性别 */ @TableField(value = "sex") privateSexEnum sex; /** * 版本 */ @TableField(value = "version",update = "%s+1") privateInteger version; /** * 时间字段,自动添加 */ @TableField(value = "create_time",fill = FieldFill.INSERT) privateLocalDateTime createTime; } 配置文件扫描枚举 配置文件扫描枚举 mybatis-plus: # 支持统配符 * 或者 ; 分割 typeEnumsPackage:com.wjbgn.*.enums 定义配置文件 定义配置文件 @Bean publicMybatisPlusPropertiesCustomizer mybatisPlusPropertiesCustomizer{ returnproperties -> { GlobalConfig globalConfig = properties.getGlobalConfig; globalConfig.setBanner( false); MybatisConfiguration configuration = newMybatisConfiguration; configuration.setDefaultEnumTypeHandler(MybatisEnumTypeHandler . class) ; properties.setConfiguration(configuration); }; } 序列化枚举值为数据库值,以下我是使用的fastjson, 全局(添加在前面的配置文件中): 序列化枚举值为数据库值,以下我是使用的fastjson, 全局(添加在前面的配置文件中): Bean publicMybatisPlusPropertiesCustomizer mybatisPlusPropertiesCustomizer{ // 序列化枚举值为数据库存储值 FastJsonConfig config = newFastJsonConfig; config.setSerializerFeatures(SerializerFeature.WriteEnumUsingToString); returnproperties -> { GlobalConfig globalConfig = properties.getGlobalConfig; globalConfig.setBanner( false); MybatisConfiguration configuration = newMybatisConfiguration; configuration.setDefaultEnumTypeHandler(MybatisEnumTypeHandler . class) ; properties.setConfiguration(configuration); }; } 局部 局部 JSONField(serialzeFeatures= SerializerFeature.WriteEnumUsingToString) privateSexEnum sex; 2.6 自动填充 还记得前面提到的实体类当中的注解@TableFeild吗?当中有个属性叫做fill,通过FieldFill设置属性,这个就是做自动填充用的。 publicenumFieldFill { /** * 默认不处理 */ DEFAULT, /** * 插入填充字段 */ INSERT, /** * 更新填充字段 */ UPDATE, /** * 插入和更新填充字段 */ INSERT_UPDATE } 但是这个直接是不能使用的,需要通过实现mybatis-plus提供的接口,增加如下配置: importcom.baomidou.mybatisplus.core.handlers.MetaObjectHandler; importorg.apache.ibatis.reflection.MetaObject; importorg.springframework.stereotype.Component; importjava.time.LocalDateTime; /** * deion: 启动自动填充功能 * @return: * @author: weirx * @time: 2022/1/17 17:00 */ @Component publicclassMyMetaObjectHandlerimplementsMetaObjectHandler{ @Override publicvoidinsertFill(MetaObject metaObject){ // 起始版本 3.3.0(推荐使用) this.strictInsertFill(metaObject, "createTime", LocalDateTime . class, LocalDateTime. now) ; } @Override publicvoidupdateFill(MetaObject metaObject){ // 起始版本 3.3.0(推荐) this.strictUpdateFill(metaObject, "updateTime", LocalDateTime . class, LocalDateTime. now) ; } } 字段如下: /** * 时间字段,自动添加 */ @TableField(value = "create_time",fill = FieldFill.INSERT) privateLocalDateTime createTime; 2.7 多数据源 前面提到过,配置文件当中配置了主从的方式,其实mybatis-plus还支持更多的方式: 多主多从 多主多从 spring: datasource: dynamic: primary:master#设置默认的数据源或者数据源组,默认值即为master strict:false#严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源 datasource: master_1: master_2: slave_1: slave_2: slave_3: 多种数据库 多种数据库 spring: datasource: dynamic: primary:mysql#设置默认的数据源或者数据源组,默认值即为master strict:false#严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源 datasource: mysql: oracle: postgresql: h2: sqlserver: 混合配置 混合配置 spring: datasource: dynamic: primary:master#设置默认的数据源或者数据源组,默认值即为master strict:false#严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源 datasource: master_1: slave_1: slave_2: oracle_1: oracle_2: 上面的三种方式,除了混合配置,我觉得都有肯能出现的吧。 @DS注解 @DS注解 可以注解在方法上或类上, 同时存在就近原则 【方法上注解】 优先于 【类上注解】: @DS( "slave_1") publicclassUserServiceImplextendsServiceImpl< UserMapper, UserDO> implementsIUserService{ @DS( "salve_1") @Override publicList getList{ returnthis.getList; } @DS( "master") @Override publicintsaveUser(UserDO userDO){ booleansave = this.save(userDO); if(save){ return1; } else{ return0; } } } 三、测试 经过上面的配置,下面开始进入测试验证阶段。 建立一张表: CREATETABLE`user`( `id`int( 11) NOTNULLAUTO_INCREMENT, `nickname`varchar( 255) NOTNULLCOMMENT'昵称', `sex`tinyint( 1) NOTNULLCOMMENT'性别,1男2女', `create_time`datetime NOTNULLCOMMENT'创建时间', `is_delete`tinyint( 1) NOTNULLDEFAULT'0'COMMENT'是否删除 1是,0否', PRIMARY KEY( `id`) ) ENGINE= InnoDBAUTO_INCREMENT= 50DEFAULTCHARSET=utf8mb4; controller: /** * @deion: 用户controller * @author:weirx * @date:2022/1/17 17:39 * @version:3.0 */ @RestController @RequestMapping( "/user") publicclassUserController{ @Autowired privateIUserService userService; /** * deion: 新增 * @return: boolean * @author: weirx * @time: 2022/1/17 19:11 */ @RequestMapping( "/save") publicbooleansave{ UserDO userDO = newUserDO; userDO.setNickname( "大漂亮"); userDO.setSex(SexEnum.MAN); returnuserService.save(userDO); } /** * deion: 修改 * @paramnickname * @paramid * @return: boolean * @author: weirx * @time: 2022/1/17 19:11 */ @RequestMapping( "/update") publicbooleanupdate(@RequestParam String nickname,@RequestParam Long id){ UserDO userDO = newUserDO; userDO.setNickname(nickname); userDO.setId(id); returnuserService.updateById(userDO); } /** * deion: 删除 * @paramid * @return: boolean * @author: weirx * @time: 2022/1/17 19:11 */ @RequestMapping( "/delete") publicbooleandelete(@RequestParam Long id){ UserDO userDO = newUserDO; userDO.setId(id); returnuserService.removeById(userDO); } /** * deion: 列表 * @return: java.util.List * @author: weirx * @time: 2022/1/17 19:11 */ @RequestMapping( "/list") publicList list{ returnuserService.list; } /** * deion: 分页列表 * @paramcurrent * @paramsize * @return: com.baomidou.mybatisplus.extension.plugins.pagination.Page * @author: weirx * @time: 2022/1/17 19:11 */ @RequestMapping( "/page") publicPage page(@RequestParam intcurrent,@RequestParam intsize) { returnuserService.page( newPage(current,size), newQueryWrapper( newUserDO)); } } 记过上面的接口验证,功能没有问题,集成成功。 项目源码地址 https://gitee.com/wei_rong_xin/rob-necessities 1、 京东一面:MySQL 中的 distinct 和 group by 哪个效率更高?太刁钻了吧! 2、 使用 try-catch 捕获异常真的会影响性能? 3、你的 IDE 太重了,试试 Emacs吧! 4、还在手写CRUD代码?试试这款代码生成工具吧,彻底解放双手! 5、JetBrains 如何看待自己的软件在中国被频繁破解? 6、无话可说,北邮211本科不符合华为OD要求,清华硕士符合! 7、RESTful真垃圾?试试 GraphQL? 8、这 7 个GitHub仓库,够学一辈子! 9、低欲望的后厂村:“遍地”985、211,高收入低消费,偏爱996 10、Javalin:一个超轻量级Web Framework! 返回搜狐,查看更多 |
今日新闻 |
推荐新闻 |
CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |